Update main project README #19743
Update main project README #19743
Conversation
mkaz
added
[Type] Developer Documentation
|
Just one note:
We should be consistent with how "block editor" is capitalized (or not). Otherwise, looks good! |
|
Good suggestion @youknowriad, I updated the plugin readme with similar content. |
mkaz
force-pushed
the
update/main-readme
branch
from
92ab48b
to
437d0e6
Compare
mkaz
removed
the
Needs Copy Review
mkaz
force-pushed
the
update/main-readme
branch
from
437d0e6
to
43c790f
Compare
There was a problem hiding this comment.
This is looking good to me but I'd appreciate validation from others. Thoughts @jasmussen
|
I'm out with a sore throat today, but will take a look first thing in the morning, unless this damn throat keeps me bedside! :D |
|
Left a bunch of comments but the important one is the first paragraph in both the Github MD and the plugin TXT. In my opinion that first paragraph should:
@michelleweber I see you've already helped out. Might we kindly ask for help on that first paragraph? Thank you! Overall, excellent work, thanks so much for doing this. Oh, and let's include a better screenshot:
We will very likely want to update that screenshot many times in the future, but until then, the above one is better :) |
|
@jasmussen, what about something like:
|
|
Thank you Michelle, your words are wonderful. Perhaps I'm being overlay Danish (jantelov and so on), but could we change this:
to this
? |
|
@jasmussen Be Danish. I adjusted the text 👍 |
|
Denmark underrepresent! The revolution will be careful! |
|
I fully support this injection of Danishness. |
Update main project repository reamde with various updates that bring it current for now and down the line. First organized it into a more general getting started recognizing the three levels that people might be coming to the project: as a User, as a Devleoper, and as a Contributor For User - added links to the user documentation, support forums, and how to report an issue For Develoepr - added links to the developer documentation For Contributor - simplifed the contributor sections and links to the contributors guide I removed the links at the bottom since those are mostly dated from when the project was starting out and justifying itself. These links can be included elsewhere for background and context, and not necessary on the welcoming page.
Thanks for the updates 👍 Co-Authored-By: Chris Van Patten <hello@chrisvanpatten.com>
mkaz
force-pushed
the
update/main-readme
branch
from
15361b6
to
3c669c7
Compare
This is the first part of updating the Gutenberg docs to match the current state, I'm going to submit as separate PRs so it focuses discussion for each piece. The Contributors Handbook is the second part for updates.
Description
Update the main project repository readme with various updates that bring it current for now and down the line.
First organized it into a more general getting started recognizing the three levels that people might be coming to the project: as a User, as a Developer, and as a Contributor
For User - added links to the user documentation, support forums, and how to report an issue
For Developer - added links to the developer documentation
For Contributor - simplified the contributor sections and links to the contributors' guide
I removed the links at the bottom since those are mostly dated from when the project was starting out and justifying itself. These links can be included elsewhere for background and context, and not necessarily on the welcoming page.
Types of changes
Documentation.
You can view the rendered version on the branch here